<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GdaDataAccessWrapper: GNOME Data Access 5 manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GNOME Data Access 5 manual">
<link rel="up" href="data_models.html" title="Data handling">
<link rel="prev" href="libgda-5.0-GdaDataPivot.html" title="GdaDataPivot">
<link rel="next" href="GdaDataModelArray.html" title="GdaDataModelArray">
<meta name="generator" content="GTK-Doc V1.32 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#GdaDataAccessWrapper.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GdaDataAccessWrapper.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
                  <a href="#GdaDataAccessWrapper.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#GdaDataAccessWrapper.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="data_models.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libgda-5.0-GdaDataPivot.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GdaDataModelArray.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GdaDataAccessWrapper"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GdaDataAccessWrapper.top_of_page"></a>GdaDataAccessWrapper</span></h2>
<p>GdaDataAccessWrapper — Offers a random access on top of a cursor-only access data model</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GdaDataAccessWrapper.stability-level"></a><h2>Stability Level</h2>
<a href="http://foldoc.org/Stable"><span class="acronym">Stable</span></a>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="GdaDataAccessWrapper.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="GdaDataModel.html" title="GdaDataModel"><span class="returnvalue">GdaDataModel</span></a> *
</td>
<td class="function_name">
<a class="link" href="GdaDataAccessWrapper.html#gda-data-access-wrapper-new" title="gda_data_access_wrapper_new ()">gda_data_access_wrapper_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GdaDataAccessWrapper.html#gda-data-access-wrapper-set-mapping" title="gda_data_access_wrapper_set_mapping ()">gda_data_access_wrapper_set_mapping</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GdaDataAccessWrapper.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody><tr>
<td class="property_type">
<a class="link" href="GdaDataModel.html" title="GdaDataModel"><span class="type">GdaDataModel</span></a> *</td>
<td class="property_name"><a class="link" href="GdaDataAccessWrapper.html#GdaDataAccessWrapper--model" title="The “model” property">model</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GdaDataAccessWrapper.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GdaDataAccessWrapper.html#GdaDataAccessWrapper-struct" title="struct GdaDataAccessWrapper">GdaDataAccessWrapper</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GdaDataAccessWrapper.html#GdaDataAccessWrapperClass" title="struct GdaDataAccessWrapperClass">GdaDataAccessWrapperClass</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GdaDataAccessWrapper.html#GdaDataAccessWrapperPrivate" title="GdaDataAccessWrapperPrivate">GdaDataAccessWrapperPrivate</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GdaDataAccessWrapper.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
    <span class="lineart">╰──</span> GdaDataAccessWrapper
</pre>
</div>
<div class="refsect1">
<a name="GdaDataAccessWrapper.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GdaDataAccessWrapper implements
 <a class="link" href="GdaDataModel.html" title="GdaDataModel">GdaDataModel</a>.</p>
</div>
<div class="refsect1">
<a name="GdaDataAccessWrapper.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;virtual/gda-ldap-connection.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="GdaDataAccessWrapper.description"></a><h2>Description</h2>
<p>The <a class="link" href="GdaDataAccessWrapper.html" title="GdaDataAccessWrapper"><span class="type">GdaDataAccessWrapper</span></a> object simply wraps another <a class="link" href="GdaDataModel.html" title="GdaDataModel"><span class="type">GdaDataModel</span></a> data model object
and allows data to be accessed in a random way while remaining memory efficient as much as possible.</p>
</div>
<div class="refsect1">
<a name="GdaDataAccessWrapper.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gda-data-access-wrapper-new"></a><h3>gda_data_access_wrapper_new ()</h3>
<pre class="programlisting"><a class="link" href="GdaDataModel.html" title="GdaDataModel"><span class="returnvalue">GdaDataModel</span></a> *
gda_data_access_wrapper_new (<em class="parameter"><code><a class="link" href="GdaDataModel.html" title="GdaDataModel"><span class="type">GdaDataModel</span></a> *model</code></em>);</pre>
<p>Creates a new <a class="link" href="GdaDataModel.html" title="GdaDataModel"><span class="type">GdaDataModel</span></a> object which buffers the rows of <em class="parameter"><code>model</code></em>
. This object is useful
only if <em class="parameter"><code>model</code></em>
 can only be accessed using cursor based method.</p>
<div class="refsect3">
<a name="gda-data-access-wrapper-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>model</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdaDataModel.html" title="GdaDataModel"><span class="type">GdaDataModel</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gda-data-access-wrapper-new.returns"></a><h4>Returns</h4>
<p>a pointer to the newly created <a class="link" href="GdaDataModel.html" title="GdaDataModel"><span class="type">GdaDataModel</span></a>. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gda-data-access-wrapper-set-mapping"></a><h3>gda_data_access_wrapper_set_mapping ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gda_data_access_wrapper_set_mapping (<em class="parameter"><code><a class="link" href="GdaDataAccessWrapper.html" title="GdaDataAccessWrapper"><span class="type">GdaDataAccessWrapper</span></a> *wrapper</code></em>,
                                     <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *mapping</code></em>,
                                     <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> mapping_size</code></em>);</pre>
<p><em class="parameter"><code>wrapper</code></em>
 will report as many columns as <em class="parameter"><code>mapping_size</code></em>
, and for each value at position 'i' in <em class="parameter"><code>mapping</code></em>
,
<em class="parameter"><code>wrapper</code></em>
 will report the 'i'th column, mapped to the wrapped data model column at position mapping[i].
For example if mapping is {3, 4, 0}, then <em class="parameter"><code>wrapper</code></em>
 will report 3 columns, respectively mapped to the 4th,
5th and 1st columns of the wrapped data model (as column numbers start at 0).</p>
<p>If <em class="parameter"><code>mapping</code></em>
 is <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, then no mapping is done and <em class="parameter"><code>wrapper</code></em>
's columns will be the same as the wrapped
data model.</p>
<p>If a column in <em class="parameter"><code>mapping</code></em>
 does not exist in the wrapped data model, then it is simply ignored (no error
reported).</p>
<p>Please note that if <em class="parameter"><code>wrapper</code></em>
 has already been used and if the wrapped data model offers a cursor forward
access mode, then this method will return <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> and no action will be done.</p>
<p>If the mapping is applied, then any existing iterator will be invalid, and <em class="parameter"><code>wrapper</code></em>
 is reset as if it
had just been created.</p>
<div class="refsect3">
<a name="gda-data-access-wrapper-set-mapping.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>wrapper</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdaDataAccessWrapper.html" title="GdaDataAccessWrapper"><span class="type">GdaDataAccessWrapper</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>mapping</p></td>
<td class="parameter_description"><p>an array of <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> which represents the mapping between <em class="parameter"><code>wrapper</code></em>
's columns
and the columns of the wrapped data model. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>][<a href="http://foldoc.org/array"><span class="acronym">array</span></a> length=mapping_size]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>mapping_size</p></td>
<td class="parameter_description"><p>the size of <em class="parameter"><code>mapping</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gda-data-access-wrapper-set-mapping.returns"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the mapping actually changed</p>
</div>
<p class="since">Since: 5.2</p>
</div>
</div>
<div class="refsect1">
<a name="GdaDataAccessWrapper.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GdaDataAccessWrapper-struct"></a><h3>struct GdaDataAccessWrapper</h3>
<pre class="programlisting">struct GdaDataAccessWrapper;</pre>
</div>
<hr>
<div class="refsect2">
<a name="GdaDataAccessWrapperClass"></a><h3>struct GdaDataAccessWrapperClass</h3>
<pre class="programlisting">struct GdaDataAccessWrapperClass {
	GObjectClass                   parent_class;
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GdaDataAccessWrapperPrivate"></a><h3>GdaDataAccessWrapperPrivate</h3>
<pre class="programlisting">typedef struct _GdaDataAccessWrapperPrivate GdaDataAccessWrapperPrivate;</pre>
</div>
</div>
<div class="refsect1">
<a name="GdaDataAccessWrapper.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GdaDataAccessWrapper--model"></a><h3>The <code class="literal">“model”</code> property</h3>
<pre class="programlisting">  “model”                    <a class="link" href="GdaDataModel.html" title="GdaDataModel"><span class="type">GdaDataModel</span></a> *</pre>
<p>Data model being wrapped.</p>
<p>Owner: GdaDataAccessWrapper</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
</div>
<div class="refsect1">
<a name="GdaDataAccessWrapper.see-also"></a><h2>See Also</h2>
<p><a class="link" href="GdaDataModel.html" title="GdaDataModel"><span class="type">GdaDataModel</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.32</div>
</body>
</html>